Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Read geometry information from t8code #1900

Merged
merged 55 commits into from
May 10, 2024

Conversation

jmark
Copy link
Contributor

@jmark jmark commented Apr 8, 2024

This PR adds geometry information retrieval from t8code into Trixi datastructures. As of now, only for Quads and Hexs.

The following idea might be implemented in the future. But there is no real use case right now.
Currently, geometry information is read in during initialization phase. The plan is to change this such that the geometry information is retrieved whenever the mesh changes due to adaptation. This gives much more flexibility and has some other advantages. Thus, this PR is still a draft.

Copy link
Contributor

github-actions bot commented Apr 8, 2024

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@sloede
Copy link
Member

sloede commented Apr 8, 2024

Very cool feature, looking forward to it 😊

@benegee
Copy link
Contributor

benegee commented Apr 9, 2024

Moved the cubed sphere constructor here, making use of the new very convenient constructor which sets up tree_node_coordinates.

Copy link

codecov bot commented Apr 9, 2024

Codecov Report

Attention: Patch coverage is 96.42857% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 96.09%. Comparing base (8a9fc7b) to head (3158c44).

Files Patch % Lines
src/meshes/t8code_mesh.jl 96.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1900      +/-   ##
==========================================
- Coverage   96.09%   96.09%   -0.00%     
==========================================
  Files         453      453              
  Lines       36461    36481      +20     
==========================================
+ Hits        35036    35055      +19     
- Misses       1425     1426       +1     
Flag Coverage Δ
unittests 96.09% <96.43%> (-<0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jmark
Copy link
Contributor Author

jmark commented Apr 19, 2024

The PR is feature complete but needs some testing, reviewing and polishing. Furthermore, this PR depends on the latest developments in t8code, namely t8code version 2... The release is not public yet as are the Julia bindings for that. Hence, this PR has to wait for the t8code release before being ready for merging.

@jmark
Copy link
Contributor Author

jmark commented Apr 19, 2024

@benegee Please test your elixirs and add them to the test harness.

benegee added 3 commits April 22, 2024 11:21
it refers to level of refinement in lat lon direction, not number of
tree as in the p4est version
@benegee
Copy link
Contributor

benegee commented Apr 22, 2024

I added the tests. But I will need to adapt the error figures once the CI jobs are running.

src/meshes/t8code_mesh.jl Outdated Show resolved Hide resolved
src/meshes/t8code_mesh.jl Outdated Show resolved Hide resolved
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I just had a quick look at some parts. It would be great to get a full review from @sloede

src/solvers/dgsem_t8code/containers_2d.jl Outdated Show resolved Hide resolved
src/meshes/t8code_mesh.jl Show resolved Hide resolved
src/meshes/t8code_mesh.jl Show resolved Hide resolved
src/meshes/t8code_mesh.jl Outdated Show resolved Hide resolved
src/solvers/dgsem_t8code/containers_3d.jl Outdated Show resolved Hide resolved
test/test_t8code_2d.jl Outdated Show resolved Hide resolved
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First part of my review - I still need to finish src/meshes/t8code_mesh.jl

src/Trixi.jl Outdated Show resolved Hide resolved
src/auxiliary/auxiliary.jl Outdated Show resolved Hide resolved
src/auxiliary/auxiliary.jl Outdated Show resolved Hide resolved
test/test_t8code_2d.jl Outdated Show resolved Hide resolved
test/test_t8code_2d.jl Outdated Show resolved Hide resolved
src/meshes/t8code_mesh.jl Outdated Show resolved Hide resolved
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second (and final) part of my review.

Overall I think there is not much to change, so this should be good to merge soon!

src/meshes/t8code_mesh.jl Outdated Show resolved Hide resolved
src/meshes/t8code_mesh.jl Outdated Show resolved Hide resolved
src/meshes/t8code_mesh.jl Outdated Show resolved Hide resolved
Johannes Markert and others added 11 commits May 8, 2024 14:41
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
Co-authored-by: Hendrik Ranocha <[email protected]>
Co-authored-by: Hendrik Ranocha <[email protected]>
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
…mework/Trixi.jl into feature-t8code-curved-geometry
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
…mework/Trixi.jl into feature-t8code-curved-geometry
@jmark
Copy link
Contributor Author

jmark commented May 8, 2024

@sloede @ranocha Incorporated your suggestions. I kindly ask for a second round of review.

sloede
sloede previously approved these changes May 8, 2024
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, LGTM!

@sloede
Copy link
Member

sloede commented May 8, 2024

@ranocha would you like to take a look as well? otherwise, this can be merged

src/solvers/dgsem_t8code/containers_2d.jl Outdated Show resolved Hide resolved
src/solvers/dgsem_t8code/containers_3d.jl Outdated Show resolved Hide resolved
@jmark
Copy link
Contributor Author

jmark commented May 10, 2024

@sloede @ranocha The PR should be ready for merge. Thank you very much for your reviews!

@ranocha ranocha merged commit d1c20c6 into main May 10, 2024
38 checks passed
@ranocha ranocha deleted the feature-t8code-curved-geometry branch May 10, 2024 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants